/*
 * Copyright 2001-2005 (C) MetaStuff, Ltd. All Rights Reserved.
 *
 * This software is open source.
 * See the bottom of this file for the licence.
 */

package org.dom4j.io;

import javax.xml.transform.sax.SAXSource;

import org.dom4j.Document;
import org.dom4j.Node;

import org.xml.sax.InputSource;
import org.xml.sax.XMLFilter;
import org.xml.sax.XMLReader;

/**
 * <p> <code>DocumentSource</code> implements a JAXP {@link SAXSource}for a
 * {@linkDocument}. </p>
 * 
 * @author <a href="mailto:james.strachan@metastuff.com">James Strachan </a>
 * @version $Revision: 1.2 $
 */
public class DocumentSource extends SAXSource
{
   /**
    * If {@link javax.xml.transform.TransformerFactory#getFeature}returns
    * <code>true</code> when passed this value as an argument then the
    * Transformer natively supports <i>dom4j </i>.
    */
   public static final String DOM4J_FEATURE =
      "http://org.dom4j.io.DoucmentSource/feature";

   /** The XMLReader to use */
   private XMLReader xmlReader = new SAXWriter();

   /**
    * Creates a JAXP {@link SAXSource}for the given {@link Node}.
    * 
    * @param node DOCUMENT ME!
    */
   public DocumentSource(Node node)
   {
      setDocument(node.getDocument());
   }

   /**
    * Creates a JAXP {@link SAXSource}for the given {@link Document}.
    * 
    * @param document DOCUMENT ME!
    */
   public DocumentSource(Document document)
   {
      setDocument(document);
   }

   // Properties
   // -------------------------------------------------------------------------

   /**
    * DOCUMENT ME!
    * 
    * @return the document which is being used as the JAXP {@link SAXSource}
    */
   public Document getDocument()
   {
      DocumentInputSource source = (DocumentInputSource) getInputSource();
      return source.getDocument();
   }

   /**
    * Sets the document used as the JAXP {@link SAXSource}
    * 
    * @param document DOCUMENT ME!
    */
   public void setDocument(Document document)
   {
      super.setInputSource(new DocumentInputSource(document));
   }

   // Overloaded methods
   // -------------------------------------------------------------------------

   /**
    * DOCUMENT ME!
    * 
    * @return the XMLReader to be used for the JAXP {@link SAXSource}.
    */
   public XMLReader getXMLReader()
   {
      return xmlReader;
   }

   /**
    * This method is not supported as this source is always a {@linkDocument}
    * instance.
    * 
    * @param inputSource DOCUMENT ME!
    * 
    * @throws UnsupportedOperationException as this method is unsupported
    */
   public void setInputSource(InputSource inputSource)
      throws UnsupportedOperationException
   {
      if(inputSource instanceof DocumentInputSource)
      {
         super.setInputSource((DocumentInputSource) inputSource);
      }
      else
      {
         throw new UnsupportedOperationException();
      }
   }

   /**
    * Sets the XMLReader used for the JAXP {@link SAXSource}.
    * 
    * @param reader DOCUMENT ME!
    * 
    * @throws UnsupportedOperationException DOCUMENT ME!
    */
   public void setXMLReader(XMLReader reader)
      throws UnsupportedOperationException
   {
      if(reader instanceof SAXWriter)
      {
         this.xmlReader = (SAXWriter) reader;
      }
      else if(reader instanceof XMLFilter)
      {
         XMLFilter filter = (XMLFilter) reader;

         while(true)
         {
            XMLReader parent = filter.getParent();

            if(parent instanceof XMLFilter)
            {
               filter = (XMLFilter) parent;
            }
            else
            {
               break;
            }
         }

         // install filter in SAXWriter....
         filter.setParent(xmlReader);
         xmlReader = filter;
      }
      else
      {
         throw new UnsupportedOperationException();
      }
   }
}

/*
 * Redistribution and use of this software and associated documentation
 * ("Software"), with or without modification, are permitted provided that the
 * following conditions are met:
 * 
 * 1. Redistributions of source code must retain copyright statements and
 * notices. Redistributions must also contain a copy of this document.
 * 
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 * 
 * 3. The name "DOM4J" must not be used to endorse or promote products derived
 * from this Software without prior written permission of MetaStuff, Ltd. For
 * written permission, please contact dom4j-info@metastuff.com.
 * 
 * 4. Products derived from this Software may not be called "DOM4J" nor may
 * "DOM4J" appear in their names without prior written permission of MetaStuff,
 * Ltd. DOM4J is a registered trademark of MetaStuff, Ltd.
 * 
 * 5. Due credit should be given to the DOM4J Project - http://www.dom4j.org
 * 
 * THIS SOFTWARE IS PROVIDED BY METASTUFF, LTD. AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL METASTUFF, LTD. OR ITS CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 * 
 * Copyright 2001-2005 (C) MetaStuff, Ltd. All Rights Reserved.
 */
